home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / comms / tw215doc.arj / TEXTWIN.CFG < prev    next >
Text File  |  1993-01-04  |  13KB  |  300 lines
  1. # TEXTWIN.CFG
  2.  
  3. # This is the textwin initialisation command file.
  4. # It should contain only non-window-specific textwin subcommands, 
  5. # as this command file is executed before the textwin display module 
  6. # is fully initialised and before any windows have been created.
  7.  
  8. # The following commands are available in this file:
  9. #
  10. # colour <fg> <bg>
  11. #   where <fg> and <bg> are integers in the range 0 to 15
  12. #   Valid values depend upon the capabilities of your display
  13. #   adaptor. For colour systems: bit0=blue, bit1=green, bit2=red,
  14. #   and bit3=intensity.
  15. #   [Default: 7 1 (white on blue)]
  16. #
  17. # terminal <width> <height>
  18. #   determines the dimensions of the underlying virtual terminal
  19. #   that a window will display
  20. #   [Default: 80 25]
  21. #
  22. # mouse <kind_of_mouse>
  23. #   kind_of_mouse can be 'soft' (software mouse) or 'hard' (hardware mouse)
  24. #   Please note that this mechanism is more flexible than hardmouse
  25. #   documented below and should be used in preference to it.
  26. #   A hardware mouse may cause problems in some display modes if the
  27. #   mouse driver software doesn't know how to handle a display
  28. #   configuration correctly. For example, mode 0x54 on my S3 card
  29. #   is 132 x 43 and the mouse leaves droppings all over the screen.
  30. #   Try "mouse hard" first. If you get problems, use "mouse soft".
  31. #   (Also, note that due to extreme laziness on my part the mouse
  32. #   kind will be reported as '0' or '1' for 'soft' and 'hard' types
  33. #   respectively. This will be fixed RSN.)
  34. #   [NB: for the curious, I started using the 'mouse' subcommand rather
  35. #   than 'hardmouse' due to the (transient) introduction of a new mouse
  36. #   kind: 'pretty'. This mouse was a software driven graphical mouse.
  37. #   The mouse was drawn by redefining fonts on-the-fly. Although I got
  38. #   the code to work, I felt this feature to be simply too expensive
  39. #   in terms of code/data space and maintainability (though clever,
  40. #   the techniques used were very much 'hacks', IMHO).]
  41. #
  42. # hardmouse <on | off> [[[ NB: THIS WILL BECOME OBSOLETE RSN ]]]
  43. #   hardmouse on may cause display problems in some text display
  44. #   modes. hardmouse off results in a sluggish mouse cursor but
  45. #   with no display problems. Try hardmouse on first. If you get 
  46. #   screen corruption use hardmouse off.
  47. #   [Default: off]
  48. #
  49. # borders <on | off>
  50. #   do you want borders around windows? Borders make windows
  51. #   slower to draw when moveing/resizing and occupy screen space.
  52. #   Windows without borders can be difficult to distinguish from
  53. #   other windows and are harder to move/resize.
  54. #   [Default: on]
  55. #
  56. # default position <x> <y>
  57. #   specify the position of the next window to be created. Both 
  58. #   <x> and <y> may be negative. If <y> is negative, you'll have
  59. #   a hard time trying to drag the window to a new location!
  60. #   [Default: 0 0]
  61. #
  62. # default size <width> <height>
  63. #   specify the dimensions of the next window to be created.
  64. #   These dimensions are limited to the terminal dimensions.
  65. #   [Default: 80 25]
  66. #
  67. # default cascade <x-range> <y-range>
  68. #   where <x-range> and <y-range> specify the offset limits when
  69. #   creating new windows. A new window will be placed at a position
  70. #   somewhere between (defPosX, defPosY) and 
  71. #   (defPosX+cascadeRangeX-1, defPosY+cascadeRangeY-1), assuming
  72. #   that x-range and y-range are not zero.  Specifying zero for these
  73. #   parameters ensures that a window will appear at the default
  74. #   position. If these parameters are not zero, windows will appear
  75. #   successively further down and to the right of the screen, until
  76. #   the x-range and y-range limits are reached. That isn't very
  77. #   clear. Play with them and see!  
  78. #   [Default: 10 10]
  79. #
  80. # default character <which> <what>
  81. #   you can configure the characters used in window borders to be any
  82. #   character from the PC character set.
  83. #   Even values of <which> apply to inactive windows; odd values are
  84. #   for the active window. So, use the following values to select the
  85. #   value for <which>, and then add 1 if you want to change the character
  86. #   for the active window.
  87. #
  88. #     0:vert border      2:horz border      4:top left      6:bot left    
  89. #     8:top right       10:bot right       12:(unused)     14:(unused)     
  90. #    16:(unused)        18:(unused)        20:(unused)     22:restore        
  91. #    24:maximize        26:minimize        28:left scroll  30:right scroll    
  92. #    32:up scroll       34:down scroll     36:horz thumb   38:vert thumb 
  93. #    40:horz scrollbar  42:vert scrollbar
  94. #
  95. #   eg: to make the inactive left vertical border (<which> == 0) into a 
  96. #       smiley face (character 1) you would use this command in textwin.cfg:
  97. #           default character 0 1
  98. #
  99. #       to make the ACTIVE left vertical border (<which> == 0 + 1) into
  100. #       a column of exclamation marks (character 33) you would use:
  101. #           default character 1 33
  102. #
  103. #   This command can be used interactively too. New characters apply
  104. #   to subsequent new windows only. eg: "text def char 11 4" will change
  105. #   the bottom right corner of new active windows into a diamond.
  106. #
  107. #   If you specify a value for <which> out of the range 0 - 43 you'll
  108. #   get an error message.
  109. #
  110. #   (For the curious: the "(unused)" entries above are placeholders for
  111. #   other forms characters such as 'cross', 'T-junction', etc, which are
  112. #   not used in textwin at the moment.)
  113. #
  114. # emulation default <sess-type> [<emul-name>]
  115. #   Sets the default terminal emulation to be used for all subsequent 
  116. #   windows of the specified session type.  Telnet defaults to VT102,
  117. #   all other sessions are TTY by default.
  118. #
  119. #        <sess-type> is the session type number, encoded as follows:
  120. #                       1=Telnet
  121. #                       2=FTP
  122. #                       3=AX25
  123. #                       4=Finger
  124. #                       5=Ping
  125. #                       6=NET/ROM
  126. #                       7=Command
  127. #                       8=More
  128. #                       9=Hopcheck
  129. #                      10=Tip
  130. #                      11=PPP PAP
  131. #                      12=Dial
  132. #                      13=Query
  133. #                      14=Cache
  134. #
  135. #        <emul-name> is the name of a terminal emulation.
  136. #                    Case is irrelevant.
  137. #                    Currently available emulation names are:
  138. #                      TTY
  139. #                      VT102
  140. #                      BigVT102
  141. #
  142. # screen mode <scr_mode>
  143. #   scr_mode is the desired display mode when in textwin
  144. #
  145. # screen mono <on | off>
  146. #   If on, textwin is forced to appear on the monochrome monitor
  147. #   of a dual-monitor system.  Obscure.
  148. #
  149. # screen restore <on | off>
  150. #   Set this off if you don't want to restore the screen to its
  151. #   original state after textwin exits.  Setting this off will
  152. #   reduce memory usage by a few kilobytes (depending on your
  153. #   initial display mode).
  154. #
  155. # param <which> [<what>]
  156. #   This is a rather vaguely named subcommand which allows you to
  157. #   configure various aspects of textwin without me having to
  158. #   add too many new commands, etc.  If the <what> parameter is
  159. #   omitted, the current value is displayed.
  160. #   Both the <which> and <what> parameters are decimal integers.
  161. #   The meaning of the <what> parameter depends upon the <which>
  162. #   parameter. Hopefully the following table should make things clear:
  163. #
  164. #       which   description of <what>
  165. #         1     The ASCII value of the background character used when
  166. #               erasing the desktop. Default is 177, a half-tone block.
  167. #               Only effective within textwin.cfg.
  168. #         2     The software-mouse wibble factor.  When the mouse is
  169. #               moved onto a cell, the attribute value under the mouse
  170. #               cursor is transformed according to this formula:
  171. #                new_attr := old_attr XOR wibble_factor
  172. #               NB: changing this setting interactively will work, but
  173. #                   you will probably see mouse droppings! This is not
  174. #                   considered a bug and this behaviour will not be 
  175. #                   'fixed'.
  176. #
  177. # key <action> [<ch1> [<ch2>]]
  178. #   Allows the user to view and set the keystroke which is bound to the
  179. #   specified action.  Configurable action values are documented below.
  180. #   ch1 and ch2 specify the key codes as returned by the int 21 func 6
  181. #   service routine (direct console i/o).  If ch1 is non-zero, ch2 need
  182. #   not be specified and will be ignored. If ch2 is specified, ch1 should
  183. #   be zero.  To do this rationally, you will probably need access to a 
  184. #   table of extended key codes. (I used Appendix B of the
  185. #   "MS-DOS Programmer's Reference".)  If you want to disable keyboard
  186. #   access for a specific action, set both ch1 and ch2 to zero.
  187. #
  188. #      action  description              default key binding
  189. #        0     move window left         ALT+<left arrow>
  190. #        1     move window right        ALT+<right arrow>
  191. #        2     move window up           ALT+<up arrow>
  192. #        3     move window down         ALT+<down arrow>
  193. #        4     reduce window width      CTRL+<left arrow>
  194. #        5     increase window width    CTRL+<right arrow>
  195. #        6     reduce window height     CTRL+<up arrow>
  196. #        7     increase window height   CTRL+<down arrow>
  197. #        8     switch to next window    ALT+F6
  198. #
  199. #   For example:
  200. #      "textwin key 0 97"    causes 'a' to move the current window left
  201. #                            (this is possible, if somewhat silly!)
  202. #      "textwin key 0 0 97"  causes CTRL+F4 to move the current window left
  203. #      "textwin key 0"       shows the key codes which will cause the
  204. #                            current window to be moved left
  205.  
  206.  
  207. # Other textwin commands, NOT valid/appropriate in this file but
  208. # documented here for completeness.  As yet, not all textwin commands
  209. # are documented. Sorry.
  210. #
  211. # clock start [<x> [<y>]]
  212. #   Creates a windowed clock display. You can optionally specify
  213. #   its initial position using the <x> and <y> arguments. The clock
  214. #   appears at the top-left if no position is specified.
  215. #   I suggest that you put the command:-
  216. #      textwin clock start
  217. #   as the last line of your autoexec.net file, or enter it manually
  218. #   once on line.  Note that the former method will not give an
  219. #   accurate indication of on-line time as the clock starts long before 
  220. #   the dialer completes. Connection takes about 30 seconds for me.
  221. #
  222. # clock stop
  223. #   Destroys the clock window.
  224. #
  225. # clock reset [<seconds>]
  226. #   Resets the elapsed time to the specified number of seconds.
  227. #   Defaults to zero if no argument is supplied.
  228. #
  229. # emulation list
  230. #   Lists the names of the available terminal emulations.
  231. #
  232. # emulation session <sess-no> [<emul-name>]
  233. #   Switches the specified session to use the specified emulation.
  234. #   No change occurs if the emulation name is not known.
  235. #
  236. #   <sess-no> is the session number (0 is valid here, meaning the
  237. #             command processor)
  238.  
  239.  
  240.  
  241. # For example:
  242. #
  243. # colour 1 7
  244. # terminal 80 38
  245. # mouse hard
  246. # borders on
  247. # default position -1 0
  248. # default size 82 40
  249. # default cascade 0 0
  250.  
  251. # 84 decimal == 0x54 (132 x 43 on my generic S3 card)
  252. # screen mode 84
  253. # screen mono on
  254. # screen restore off
  255.  
  256. # The following give "chunky" scrollbars on the active window
  257. # rather than my minimalist default!
  258. # 
  259. # default character 37 219
  260. # default character 39 219
  261. # default character 41 178
  262. # default character 43 178
  263.  
  264. # The following commands make scrollbars and resize gadgets disappear 
  265. # from inactive windows (NB: the scrollbars and resize gadgets ARE still 
  266. # there, its just that the graphics for them are the same as the standard 
  267. # border...)
  268. # 
  269. # default character 22 196
  270. # default character 24 196
  271. # default character 26 196
  272. # 
  273. # default character 28 196
  274. # default character 30 196
  275. # default character 32 179
  276. # default character 34 179
  277. # default character 36 196
  278. # default character 38 179
  279. # default character 40 196
  280. # default character 42 179
  281.  
  282.  
  283. # Set Tip sessions to use the VT102 emulation (session type 10 == Tip) and 
  284. # set Telnet sessions to use BigVT102 (session type 1 == Telnet).
  285. #
  286. # emulation default 10 bigvt102
  287. # emulation default  1 vt102
  288.  
  289.  
  290. # The following lines will cause textwin to look very much like the
  291. # original 'single screen' DIS KA9Q program.
  292. #
  293. # borders off
  294. # default cascade 0 0
  295. # default position 0 0
  296. # colour 7 0
  297.  
  298.  
  299. # End of textwin.cfg
  300.